
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Overview of Model Share Module &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="model_share.tamoc_nc_file" href="../autodoc/model_share/model_share.tamoc_nc_file.html" />
    <link rel="prev" title="lmp.flux_to_velocity" href="../autodoc/bpm/lmp.flux_to_velocity.html" />
   
  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="overview-of-model-share-module">
<h1>Overview of Model Share Module<a class="headerlink" href="#overview-of-model-share-module" title="Permalink to this headline">¶</a></h1>
<dl class="field-list simple">
<dt class="field-odd">Release</dt>
<dd class="field-odd"><p>2.1</p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>Jun 05, 2020</p>
</dd>
</dl>
<span class="target" id="module-model_share"></span><div class="section" id="model-share">
<h2>Model Share<a class="headerlink" href="#model-share" title="Permalink to this headline">¶</a></h2>
<p>Provides functions that are common to all models in the TAMOC suite</p>
<p>This module defines functions that perform standard tasks for the modeling
modules in the TAMOC suite.  These include standard authoring of output 
files and reading ambient data from output files.</p>
<div class="section" id="notes">
<h3>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h3>
<p>These class objects and helper functions may be used throughout the TAMOC 
modeling suite.</p>
</div>
</div>
<div class="section" id="module-functions">
<h2>Module Functions<a class="headerlink" href="#module-functions" title="Permalink to this headline">¶</a></h2>
<p>The functions contained in this module are listed as follows:</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/model_share/model_share.tamoc_nc_file.html#model_share.tamoc_nc_file" title="model_share.tamoc_nc_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tamoc_nc_file</span></code></a>(fname, title, summary, source)</p></td>
<td><p>Write the header meta data to an netCDF file for a TAMOC output</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/model_share/model_share.profile_from_model_savefile.html#model_share.profile_from_model_savefile" title="model_share.profile_from_model_savefile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">profile_from_model_savefile</span></code></a>(nc, fname[, ctdname])</p></td>
<td><p>Load the <cite>ambient.Profile</cite> data pointed to by the netCDF file</p></td>
</tr>
</tbody>
</table>
</div>
</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../index.html">Documentation overview</a><ul>
  <li><a href="../user_manual.html">TAMOC User Manual</a><ul>
      <li>Previous: <a href="../autodoc/bpm/lmp.flux_to_velocity.html" title="previous chapter">lmp.flux_to_velocity</a></li>
      <li>Next: <a href="../autodoc/model_share/model_share.tamoc_nc_file.html" title="next chapter">model_share.tamoc_nc_file</a></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../_sources/modules/model_share.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>